package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.GregorianCalendarAddDTO;
import org.jsola.hr.dto.GregorianCalendarUpdateDTO;
import org.jsola.hr.query.GregorianCalendarQuery;
import org.jsola.hr.vo.GregorianCalendarListVO;
import org.jsola.hr.vo.GregorianCalendarVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-公历表")
public interface IGregorianCalendarControllerAPI {

    /**
     * 新增公历表
     * @param gregorianCalendarAddDTO 公历表新增实体
     * @return 公历表展示对象
     */
    @ApiOperation(value = "新增公历表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gregorianCalendarAddDTO", dataType = "GregorianCalendarAddDTO", value = "新增公历表", paramType = "body")
    })
    Result<GregorianCalendarVO> save(GregorianCalendarAddDTO gregorianCalendarAddDTO);


    /**
     * 修改公历表
     * @param gregorianCalendarUpdateDTO 公历表
     * @return 更新数量
     */
    @ApiOperation(value = "修改公历表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gregorianCalendarUpdateDTO", dataType = "GregorianCalendarUpdateDTO", value = "修改公历表", paramType = "body")
    })
    Result<Integer> update(GregorianCalendarUpdateDTO gregorianCalendarUpdateDTO);




    /**
     * 删除单个公历表，彻底删除
     * @param gregorianCalendarId 公历表id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个公历表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gregorianCalendarId", dataType = "String", value = "公历表id", paramType = "path")
    })
    Result<Integer> delete(String gregorianCalendarId);


    /**
     * 批量删除公历表，彻底删除
     * @param gregorianCalendarIds 公历表id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除公历表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gregorianCalendarIds", dataType = "String[]", value = "公历表id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] gregorianCalendarIds);


    /**
     * 根据公历表id查询公历表详情
     * @param gregorianCalendarId 公历表id
     * @return 公历表详情
     */
    @ApiOperation(value="根据公历表id查询公历表详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gregorianCalendarId", dataType = "String", value = "公历表id", paramType = "path")
    })
    Result<GregorianCalendarVO> findById(String gregorianCalendarId);


    /**
     * 查询公历表
     * @param gregorianCalendarQuery 公历表查询参数
     * @return page
     */
    @ApiOperation(value="查询公历表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gregorianCalendarQuery", dataType = "GregorianCalendarQuery", value = "公历表查询参数", paramType = "query")
    })
    Result<List<GregorianCalendarListVO>> listAll(GregorianCalendarQuery gregorianCalendarQuery);


     /**
     * 分页查询公历表
     * @param gregorianCalendarQuery 公历表查询参数
     * @return page
     */
    @ApiOperation(value="分页查询公历表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "gregorianCalendarQuery", dataType = "GregorianCalendarQuery", value = "公历表查询参数", paramType = "query")
    })
    Result<Page<GregorianCalendarListVO>> page(GregorianCalendarQuery gregorianCalendarQuery);


}

